home *** CD-ROM | disk | FTP | other *** search
/ Macwelt 1 / Macwelt DVD 1.toast / Web-Publishing / HTML-Editoren / Alpha ƒ / Tcl / Modes / Matlab mode / matlabDoc.tcl < prev    next >
Encoding:
Text File  |  2000-05-10  |  4.5 KB  |  155 lines
  1. ################################################################################
  2. #
  3. # matlabDoc.tcl, part of the matlab mode package
  4. # 
  5. # Documentation system using matlab and web browser
  6. # 
  7. ################################################################################
  8.  
  9. proc matlabDoc.tcl {} {}
  10.  
  11. ################################################################################
  12. # Main proc for getting help.
  13. # Does both web and matlab help depending on modeVar webHelp.
  14. ################################################################################
  15.  
  16. proc getMatlabHelp {command} {
  17.     global MATLmodeVars
  18.     
  19.     if {$MATLmodeVars(webHelp)} {
  20.         set docURL [findMatlabHelpFile $command]
  21.         if {$docURL != ""} {
  22.             sendUrl "$docURL"
  23.             return
  24.         }
  25.     }
  26.     
  27.     set scriptName "help $command"
  28.     matlabDoScript $scriptName 2 0 {MATL::DocReplyHandler}
  29. }
  30.  
  31. ################################################################################ 
  32. # Return the path of help directory.
  33. # It can be set by the user in the preferences, but we will 
  34. # ask Matlab if we do not already know it.  
  35. ################################################################################
  36.  
  37. proc matlabHelpDir {} {
  38.     global MATLmodeVars modifiedModeVars
  39.     
  40.     if {![info exists MATLmodeVars(MatlabHelpFolder)] || [expr {$MATLmodeVars(MatlabHelpFolder) == ""}]} {
  41.         set MATLmodeVars(MatlabHelpFolder) [string trim [matlabDoScript disp(docroot) 0 1]]
  42. #         set MatlabHelpFolder [get_directory -p "Select Matlab help folder:"]
  43.         lappend modifiedModeVars {MatlabHelpFolder MATLmodeVars}
  44.     }
  45.     
  46.     return $MATLmodeVars(MatlabHelpFolder)
  47. }
  48.  
  49.  
  50. ################################################################################
  51. #  Get the URL of a help file
  52. ################################################################################
  53.  
  54. proc findMatlabHelpFile {command} {
  55.     
  56.     set helpDir [matlabHelpDir]
  57.     if {$helpDir != ""} {
  58.         set docPath "$helpDir:techdoc:ref:$command.html"
  59.         if {[file exists $docPath]} {
  60.             regsub  -all ":" $docPath "/" docPath
  61.             return "file:///$docPath"
  62.         }
  63.     }
  64.     
  65.     set mFile [matlabWhichFile $command]
  66.     if {$mFile == ""} {return -code return}
  67.     
  68.     set docPath "[file dirname $mFile]:html:$command.html"
  69.     if {[file exists $docPath]} {
  70.         regsub  -all ":" $docPath "/" docPath
  71.         return "file:///$docPath"
  72.     }
  73.     
  74.     return ""
  75. }
  76.  
  77.  
  78. ################################################################################
  79. #  Search MATLAB documentation
  80. ################################################################################
  81.  
  82. proc matlabSearchHelp {command} {
  83.     global MATLmodeVars
  84.  
  85.     if {$MATLmodeVars(webHelp)} {
  86.         set helpDir [matlabHelpDir]
  87.         if {$helpDir == ""} {return}
  88.         
  89.         regsub -all -- ":" $helpDir "/" docPath
  90.         regsub -all -- " " $command "+" command
  91.         set docURL "file:///$docPath/searchindex.html?searchnv=$command"
  92.         sendUrl "$docURL"
  93.     } else {
  94.         set scriptName "lookfor $command"
  95.         matlabDoScript $scriptName 2 0 MATL::DocReplyHandler
  96.     }
  97. }
  98.     
  99.  
  100. ################################################################################
  101. #  Create a new window with function definition
  102. ################################################################################
  103.  
  104. proc matlabShowDefinition {name def} {
  105.     new -n "* $name *" -m MATL
  106.     insertText $def
  107.     goto [minPos]
  108.  
  109.     # Set window mode to MATLAB, so that we can follow 
  110.     # cross-references by Cmd-dbl-clicking (and colors
  111.     # are active, etc...)
  112.     
  113. #     newMode MATL
  114.     catch {shrinkWindow 1}
  115.     set win [lindex [winNames -f] 0]
  116.     setWinInfo -w $win dirty 0
  117.     setWinInfo -w $win read-only 1
  118. } 
  119.  
  120. #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+
  121. #
  122. # ◊◊◊◊ UI procs for getting help ◊◊◊◊ #
  123. #
  124. #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-
  125.  
  126. ################################################################################
  127. # Get help on selected command
  128. ################################################################################
  129.  
  130. proc matlabHelpSelection {} {
  131.     getMatlabHelp [getSelect]
  132. }
  133.  
  134.  
  135. ################################################################################
  136. #  Present a dialog to get help on a command
  137. ################################################################################
  138.  
  139. proc matlabHelp {} {
  140.     set text [getline "Enter command"]
  141.     if {$text == ""} {return}
  142.     getMatlabHelp $text
  143. }
  144.  
  145.  
  146. ################################################################################
  147. #  Present a dialog to search help on a command
  148. ################################################################################
  149.  
  150. proc matlabSearchHelpDialog {} {
  151.     set command [getline "Enter search string"]
  152.     if {$command == ""} {return}
  153.     matlabSearchHelp $command
  154. }
  155.